<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html lang="en">
<head>
<title>Source code</title>
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
</head>
<body>
<div class="sourceContainer">
<pre><span class="sourceLineNo">001</span>/*<a name="line.1"></a>
<span class="sourceLineNo">002</span> * Copyright (C) 2011 The Guava Authors<a name="line.2"></a>
<span class="sourceLineNo">003</span> *<a name="line.3"></a>
<span class="sourceLineNo">004</span> * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except<a name="line.4"></a>
<span class="sourceLineNo">005</span> * in compliance with the License. You may obtain a copy of the License at<a name="line.5"></a>
<span class="sourceLineNo">006</span> *<a name="line.6"></a>
<span class="sourceLineNo">007</span> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.7"></a>
<span class="sourceLineNo">008</span> *<a name="line.8"></a>
<span class="sourceLineNo">009</span> * Unless required by applicable law or agreed to in writing, software distributed under the License<a name="line.9"></a>
<span class="sourceLineNo">010</span> * is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express<a name="line.10"></a>
<span class="sourceLineNo">011</span> * or implied. See the License for the specific language governing permissions and limitations under<a name="line.11"></a>
<span class="sourceLineNo">012</span> * the License.<a name="line.12"></a>
<span class="sourceLineNo">013</span> */<a name="line.13"></a>
<span class="sourceLineNo">014</span><a name="line.14"></a>
<span class="sourceLineNo">015</span>package com.google.common.hash;<a name="line.15"></a>
<span class="sourceLineNo">016</span><a name="line.16"></a>
<span class="sourceLineNo">017</span>import com.google.common.annotations.Beta;<a name="line.17"></a>
<span class="sourceLineNo">018</span><a name="line.18"></a>
<span class="sourceLineNo">019</span>import java.nio.charset.Charset;<a name="line.19"></a>
<span class="sourceLineNo">020</span><a name="line.20"></a>
<span class="sourceLineNo">021</span>/**<a name="line.21"></a>
<span class="sourceLineNo">022</span> * A {@link PrimitiveSink} that can compute a hash code after reading the input. Each hasher should<a name="line.22"></a>
<span class="sourceLineNo">023</span> * translate all multibyte values ({@link #putInt(int)}, {@link #putLong(long)}, etc) to bytes<a name="line.23"></a>
<span class="sourceLineNo">024</span> * in little-endian order.<a name="line.24"></a>
<span class="sourceLineNo">025</span> *<a name="line.25"></a>
<span class="sourceLineNo">026</span> * &lt;p&gt;The result of calling any methods after calling {@link #hash} is undefined.<a name="line.26"></a>
<span class="sourceLineNo">027</span> *<a name="line.27"></a>
<span class="sourceLineNo">028</span> * &lt;p&gt;&lt;b&gt;Warning:&lt;/b&gt; Chunks of data that are put into the {@link Hasher} are not delimited.<a name="line.28"></a>
<span class="sourceLineNo">029</span> * The resulting {@link HashCode} is dependent only on the bytes inserted, and the order in which<a name="line.29"></a>
<span class="sourceLineNo">030</span> * they were inserted, not how those bytes were chunked into discrete put() operations. For example,<a name="line.30"></a>
<span class="sourceLineNo">031</span> * the following three expressions all generate colliding hash codes: &lt;pre&gt;   {@code<a name="line.31"></a>
<span class="sourceLineNo">032</span> *<a name="line.32"></a>
<span class="sourceLineNo">033</span> *   newHasher().putString("ab").putString("c").hash()<a name="line.33"></a>
<span class="sourceLineNo">034</span> *   newHasher().putString("a").putString("bc").hash()<a name="line.34"></a>
<span class="sourceLineNo">035</span> *   newHasher().putChar('a').putChar('b').putChar('c').hash()}&lt;/pre&gt;<a name="line.35"></a>
<span class="sourceLineNo">036</span> *<a name="line.36"></a>
<span class="sourceLineNo">037</span> * If you wish to avoid this, you must explicitly delimit your data chunks. For example:<a name="line.37"></a>
<span class="sourceLineNo">038</span> * &lt;pre&gt;   {@code<a name="line.38"></a>
<span class="sourceLineNo">039</span> *<a name="line.39"></a>
<span class="sourceLineNo">040</span> *   newHasher().putString("ab").putByte(DELIM).putString("c").hash()}&lt;/pre&gt;<a name="line.40"></a>
<span class="sourceLineNo">041</span> *<a name="line.41"></a>
<span class="sourceLineNo">042</span> * @author Kevin Bourrillion<a name="line.42"></a>
<span class="sourceLineNo">043</span> * @since 11.0<a name="line.43"></a>
<span class="sourceLineNo">044</span> */<a name="line.44"></a>
<span class="sourceLineNo">045</span>@Beta<a name="line.45"></a>
<span class="sourceLineNo">046</span>public interface Hasher extends PrimitiveSink {<a name="line.46"></a>
<span class="sourceLineNo">047</span>  @Override Hasher putByte(byte b);<a name="line.47"></a>
<span class="sourceLineNo">048</span>  @Override Hasher putBytes(byte[] bytes);<a name="line.48"></a>
<span class="sourceLineNo">049</span>  @Override Hasher putBytes(byte[] bytes, int off, int len);<a name="line.49"></a>
<span class="sourceLineNo">050</span>  @Override Hasher putShort(short s);<a name="line.50"></a>
<span class="sourceLineNo">051</span>  @Override Hasher putInt(int i);<a name="line.51"></a>
<span class="sourceLineNo">052</span>  @Override Hasher putLong(long l);<a name="line.52"></a>
<span class="sourceLineNo">053</span><a name="line.53"></a>
<span class="sourceLineNo">054</span>  /**<a name="line.54"></a>
<span class="sourceLineNo">055</span>   * Equivalent to {@code putInt(Float.floatToRawIntBits(f))}.<a name="line.55"></a>
<span class="sourceLineNo">056</span>   */<a name="line.56"></a>
<span class="sourceLineNo">057</span>  @Override Hasher putFloat(float f);<a name="line.57"></a>
<span class="sourceLineNo">058</span><a name="line.58"></a>
<span class="sourceLineNo">059</span>  /**<a name="line.59"></a>
<span class="sourceLineNo">060</span>   * Equivalent to {@code putLong(Double.doubleToRawLongBits(d))}.<a name="line.60"></a>
<span class="sourceLineNo">061</span>   */<a name="line.61"></a>
<span class="sourceLineNo">062</span>  @Override Hasher putDouble(double d);<a name="line.62"></a>
<span class="sourceLineNo">063</span><a name="line.63"></a>
<span class="sourceLineNo">064</span>  /**<a name="line.64"></a>
<span class="sourceLineNo">065</span>   * Equivalent to {@code putByte(b ? (byte) 1 : (byte) 0)}.<a name="line.65"></a>
<span class="sourceLineNo">066</span>   */<a name="line.66"></a>
<span class="sourceLineNo">067</span>  @Override Hasher putBoolean(boolean b);<a name="line.67"></a>
<span class="sourceLineNo">068</span>  @Override Hasher putChar(char c);<a name="line.68"></a>
<span class="sourceLineNo">069</span><a name="line.69"></a>
<span class="sourceLineNo">070</span>  /**<a name="line.70"></a>
<span class="sourceLineNo">071</span>   * Equivalent to processing each {@code char} value in the {@code CharSequence}, in order.<a name="line.71"></a>
<span class="sourceLineNo">072</span>   * The input must not be updated while this method is in progress.<a name="line.72"></a>
<span class="sourceLineNo">073</span>   */<a name="line.73"></a>
<span class="sourceLineNo">074</span>  @Override Hasher putString(CharSequence charSequence);<a name="line.74"></a>
<span class="sourceLineNo">075</span><a name="line.75"></a>
<span class="sourceLineNo">076</span>  /**<a name="line.76"></a>
<span class="sourceLineNo">077</span>   * Equivalent to {@code putBytes(charSequence.toString().getBytes(charset))}.<a name="line.77"></a>
<span class="sourceLineNo">078</span>   */<a name="line.78"></a>
<span class="sourceLineNo">079</span>  @Override Hasher putString(CharSequence charSequence, Charset charset);<a name="line.79"></a>
<span class="sourceLineNo">080</span><a name="line.80"></a>
<span class="sourceLineNo">081</span>  /**<a name="line.81"></a>
<span class="sourceLineNo">082</span>   * A simple convenience for {@code funnel.funnel(object, this)}.<a name="line.82"></a>
<span class="sourceLineNo">083</span>   */<a name="line.83"></a>
<span class="sourceLineNo">084</span>  &lt;T&gt; Hasher putObject(T instance, Funnel&lt;? super T&gt; funnel);<a name="line.84"></a>
<span class="sourceLineNo">085</span><a name="line.85"></a>
<span class="sourceLineNo">086</span>  /**<a name="line.86"></a>
<span class="sourceLineNo">087</span>   * Computes a hash code based on the data that have been provided to this hasher. The result is<a name="line.87"></a>
<span class="sourceLineNo">088</span>   * unspecified if this method is called more than once on the same instance.<a name="line.88"></a>
<span class="sourceLineNo">089</span>   */<a name="line.89"></a>
<span class="sourceLineNo">090</span>  HashCode hash();<a name="line.90"></a>
<span class="sourceLineNo">091</span>}<a name="line.91"></a>




























































</pre>
</div>
</body>
</html>
